Skip to main content

Get Files via FTP

Description

Get a file with FTP is a Process Entry in the File Transfer plugin for Process Studio Processes. Get a File with FTP process entry retrieves one or more files from the specified remote directory via an FTP server.

Note: Some FTP servers do not allow files to be FTP'ed when they contain certain characters (spaces for example). Therefore, when choosing filenames for files to be FTP'ed, be sure to check upfront whether your particular FTP server is able to process your kind of filenames.

Configurations

No.Field NameDescription
1Process Entry nameSpecify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
Server:
1FTP server name / IP addressThe name of the SFTP server or the IP address
2Server PortThe TCP port to use. This is usually 22
3User nameThe user name to log into the SFTP server
4PasswordThe password to log into the SFTP server
5Proxy typeSelect from the list: HTTP/SOCKS5
6Proxy hostProxy server host name
7Proxy portProxy server port number
8Proxy usernameProxy server account user name
9Proxy passwordProxy server account password
Advanced:
1Binary mode?Enable if files must be transferred in binary mode
2TimeoutThe FTP server timeout in seconds
3Use active FTP connectionEnable if you are connecting to the FTP server using Active mode; you must set your firewall to accept connections to the port that your FTP client will open. The default is Passive mode.
4Control encodingEncoding matters when retrieving file names that contain special characters. For Western Europe and the USA, ISO-8859-1 usually suffices. Select encoding that is valid for your server.
Files tab:
1Process Entry nameSpecify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
Remote:
1Remote DirectoryThe remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists.
2Wildcard (regular expression)Specify a regular expression here if you want to select multiple files.
3Remove files after retrieval?Delete the remote file after the file is transferred.
4Move files after retrieval?Enable checkbox to move files after retrieval
5Move to a folderMoves files to specified folder
6Create a folderCreates folder that will contain files
Local:
1Target DirectoryThe remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists.
2Include date in filenameAdds the system date to the filename (_20101231)
3Include time in filenameAdds the system time to the filename (_235959)
4Specify date time formatEnable to provide your own date/time format; the default is yyyyMMdd'_'HHmmss
5Date time formatSelect date time format
6Add date before extensionAdds date to the file name before the extension
7Don't overwrite filesEnable to skip, rename, or fail if a file with an identical name already exists in the target directory
8If file existsAction to take if a file with an identical name already exists in the target directory
9Add filenames to resultIf checked the name of the file is added to the result stream.
Advanced tab
Success Condition:
1Success onSets conditions of success
2Limit filesSets number of files associated with a condition of success
Socks Proxy Tab
Proxy:
1HostSocks Proxy host name
2PortSocks Proxy port number
3UsernameUser name associated with the Socks Proxy account
4PasswordPassword associated with the Socks Proxy account